Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 21, 2025

Fixes #5315

This PR updates the Aspire orchestration overview documentation to include coverage of AddCSharpApp and CSharpAppResource, which were added in Aspire 9.5 to support C# file-based apps and provide an alternative way to add C# projects to the app model without requiring project references.

Changes

Built-in resource types table

Added a new row documenting the AddCSharpApp method and CSharpAppResource type, positioned directly after AddProject to show the relationship between the two approaches.

Enhanced project resources introduction

Updated the introductory paragraph to mention both methods for adding C# projects to the app model, noting that AddCSharpApp provides an alternative that doesn't require a project reference.

New AddCSharpApp documentation section

Added comprehensive documentation explaining:

  • How AddCSharpApp differs from AddProject (path-based vs project reference)
  • When to use AddCSharpApp (file-based apps from .NET 10, or projects without adding references)
  • Code examples showing usage with both .cs files and project directories:
    // Adds a file-based C# app "inventoryservice" from a .cs file.
    var inventoryService = builder.AddCSharpApp("inventoryservice", @"..\InventoryService.cs");
    
    // Adds a C# project "catalogservice" from a project directory.
    var catalogService = builder.AddCSharpApp("catalogservice", @"..\CatalogService");
  • Configuration compatibility with AddProject (replicas, environment variables, resource dependencies)
  • A note explaining the experimental status and .NET 10 SDK requirement for file-based apps

All changes follow the repository's documentation guidelines and have been validated with markdownlint.

Original prompt

Please work on issue #5315 - updating app-host-overview.md


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/fundamentals/app-host-overview.md Aspire orchestration overview

…view.md

Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com>
Copilot AI changed the title [WIP] Update app host overview documentation Add AddCSharpApp and CSharpAppResource documentation to app-host-overview.md Oct 21, 2025
Copilot AI requested a review from IEvangelist October 21, 2025 12:08
Copilot finished work on behalf of IEvangelist October 21, 2025 12:09
@IEvangelist IEvangelist marked this pull request as ready for review October 23, 2025 12:16
@IEvangelist IEvangelist merged commit 7d37af5 into release-13 Oct 24, 2025
6 checks passed
@IEvangelist IEvangelist deleted the copilot/update-app-host-overview-md branch October 24, 2025 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants